home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Applications 1996 May / SGI IRIX 6.2 Applications 1996 May.iso / dist / impr_dev.idb / usr / impressario / man / README.z / README
Text File  |  1996-05-06  |  3KB  |  50 lines
  1.  
  2. Impressario Product Manual Page Templates
  3.  
  4. This directory contains templates for manual pages. It is recommended that an
  5. Impressario support product contain at least a manual page describing the
  6. product. This manual page is typically given the name of the product.
  7. Additional manual pages may also be distributed. These additional manual
  8. pages can describe any driver or filter programs provided by the product.
  9. Edit the templates as appropriate for your product.
  10.  
  11. Manual pages are created using the UNIX text formatting language of the
  12. nroff(1) program. The nroff program is part of the Documenter's Workbench
  13. product. This product is an option product sold separately. Refer to the
  14. documentation provided with the Documenter's Workbench product for a
  15. complete description of the nroff formatting language. The templates provided
  16. here should allow a manual page to be created with a minimal understanding
  17. of the formatting language. Note that you must have the Documenter's
  18. Workbench program installed on the development system in order to create a
  19. man page for your product.
  20.  
  21. Source manual pages are given the suffix of the UNIX manual section they
  22. represent. For an Impressario printing support product this will typically
  23. be section 1 so the suffix to manual page source files will be '.1'. For
  24. distribution a source manual page is formatted using the nroff program and
  25. compressed. The resulting "compiled" manual page will have the suffix '.z'.
  26. It is this '.z' file that is distributed with the product. The source manual
  27. page is not distributed. To create the "compiled" manual pages use the
  28. Makefile in this directory. Type 'make' to compile the source manual pages
  29. and type 'make clean' to remove any compiled manual pages. Compiled manual
  30. pages can be read in the directory in which they are created by using the
  31. command 'man -d <manpage>.z'. Note that all manual pages must be named
  32. with lowercase letters.
  33.  
  34. Typically, all Impressario manual pages (section 1 pages) should be installed
  35. in the directory /usr/share/catman/u_man/cat1.
  36.  
  37. This directory contains the following manual page source files:
  38.  
  39. product_template.1
  40.     This manual page serves as a template for an Impressario support
  41.     product manual page. Edit this manual page to describe your product.
  42.     The inclusion of a product manual page with your Impressario support
  43.     product is highly recommended.
  44.  
  45. program_template.1
  46.     This manual page is a template for a specific program within an
  47.     Impressario support product. Typical programs are drivers and
  48.     filters. Inclusion of program manual pages with your Impressario
  49.     support product is optional.
  50.